Skip to main content link. Accesskey S
  • Help
  • HCL Logo
  • HCL Notes and Domino Application Development wiki
  • THIS WIKI IS READ-ONLY. Individual names altered for privacy purposes.
  • HCL Forums and Blogs
  • Home
  • Product Documentation
  • Community Articles
  • Learning Center
  • API Documentation
Search
API Documentation > Deploying XPage Libraries
  • Share Show Menu▼
  • Subscribe Show Menu▼

Recent articles by this author

Community articleDeploying XPage Libraries
Added by ~Paul Kiretex | Edited by IBM contributor~Sean Reresongon on May 17, 2010 | Version 6
expanded Abstract
collapsed Abstract
No abstract provided.
Tags: XPages Extensiblity
This article describes how you deploy your XPages Library so that administrators who have XPage Applications that depend on certain libraries can be installed to clients. We are leveraging the Widgets technology that was introduced in 8.5.1 which allows administrators to install widgets on their users clients via policies pushed down from the Domino Server or alternatively allows users to install libraries as they need.

The first part of this article deals with deploying XPage libraries for the Notes Client

Creating the Widget Catalog
As an administrator you would create a new Widget Catalog like below on a Domino Server



Create Updatesite nsf that contains the plugins and features
After completing the steps in the previous article to create the plugin and feature for your library. There is an Eclipse Update Site template that can be used to store the plugins and features. It then can be used to host the plugins so that they can be provisioned to client machines.



After creating the updateSite, you just need to point it at the site.xml of your library and it will import the plugins and features into the nsf.





There is a handy option in the menu for showing the URL's which will need for your extension.xml so that you us can provision the plugins and features.



Creating the extension.xml
Here is a sample extension.xml file for some XPage Libraries.





providerId="com.ibm.rcp.toolbox.prov.provider.ToolboxProvisioning"

title="Test XSP 1"

url="nrpc:__8025770d0045f8df/site.xml">







id="Test_Feature_ABX" name="Test Feature ABX">










]]>




Note: Provided that shared="true" is set in the install manifest snippet ,as above, the plug-in is installed to Notes_install_dir\framework\shared\eclipse. If there is no write access to that directory, the plug-in is installed to Notes_install_dir\data\workspace\applications.

Creating a Widget in the Widget Catalog
Click on the "Add Widget to Catalog" and fill in all the fields and then attach the extension.xml to the widget.



Enabling the Widgets in your Notes Client
There are two ways to enable widgets in your Notes Client, either manually or these preferences can be pushed down using a policy. The quick way to enable Widgets, is to go to File->Preferences->Widget and fill in the fields.




Then you can choose the categories to install and it will automatically install those plugins. If you don't tick any categories, and if your administrator has give you the correct rights, you can just install the widget manually by opening the widget catalog and dragging the extension.xml across to the MyWidgets Panel.

If you are an administrator then you can create a policy which enforces what widget catalog server a users client can use and also what categories to install on the clients machine.

From DP forum- Need to add in something about this maybe so admins can install libraries and they won't appear in the MyWidgets sidebar. So the user won't mistake them as a component that can be used in composite application for example.

To answer your question about hiding a widget in the My Widgets sidebar panel... we are adding this feature to 8.5.2. You will be able to add an attribute to the widget's xml that tells the My Widgets sidebar panel to hide it.



More information on widgets can be found here: http://publib.boulder.ibm.com/infocenter/domhelp/v8r0/index.jsp?topic=/com.ibm.help.domino.admin.doc/DOC/H_CREATING_A_TOOLBOX_CATALOG_OVER.html


Deploying a XPages Library on a 8.5.2 Domino Server
In Lotus Domino Server 8.5.2 there is a new deployment method as we have moved to having OSGI on the server. In previous releases users will be familiar with deploying their libraries as jars to c:\Domino\xsp\shared\lib. For 8.5.2 your libraries will continue to work if they are located in \xsp\shared\lib but we recommend that you think about moving them to the new directories as plugins.



You need to follow the same steps as this article describing how to test your library in a Lotus Domino Designer install. Then copy the same feature and plugin to the shared directory under the OSGI folder.You will need to restart your server for your library to be installed correctly.





expanded Attachments (0)
collapsed Attachments (0)
expanded Versions (51)
collapsed Versions (51)
Version Comparison     
VersionDateChanged by              Summary of changes
51Aug 20, 2010, 10:20:55 AM~Sanjay Eklutherettu  IBM contributor
50Aug 19, 2010, 10:51:12 AM~Zelda Fezboosipulgon  IBM contributor
49Aug 6, 2010, 9:36:33 AM~Phil Fezhipivitchader  IBM contributor
48Aug 6, 2010, 8:25:15 AM~Phil Fezhipivitchader  IBM contributor
47Jul 22, 2010, 1:26:41 PM~Sean Reresongon  IBM contributor
46Jun 22, 2010, 3:42:52 PM~Olga Minfreepuloni  IBM contributor
45Jun 22, 2010, 3:39:35 PM~Olga Minfreepuloni  IBM contributor
44Jun 22, 2010, 12:32:16 PM~Sean Reresongon  IBM contributor
43Jun 22, 2010, 11:54:44 AM~Sean Reresongon  IBM contributor
42Jun 21, 2010, 1:48:37 PM~Sean Reresongon  IBM contributor
41May 25, 2010, 2:46:53 PM~Sean Reresongon  IBM contributor
40May 25, 2010, 9:19:46 AM~Sean Reresongon  IBM contributor
39May 21, 2010, 11:00:07 AM~Sean Reresongon  IBM contributor
38May 21, 2010, 10:35:06 AM~Zelda Fezboosipulgon  IBM contributor
37May 21, 2010, 10:30:15 AM~Zelda Fezboosipulgon  IBM contributor
36May 21, 2010, 9:30:40 AM~Lex Feztookonyikle  IBM contributor
35May 20, 2010, 6:47:54 PM~Sean Reresongon  IBM contributor
34May 20, 2010, 6:44:42 PM~Sean Reresongon  IBM contributor
33May 20, 2010, 6:40:42 PM~Sean Reresongon  IBM contributor
32May 20, 2010, 6:38:30 PM~Sean Reresongon  IBM contributor
31May 20, 2010, 6:36:40 PM~Sean Reresongon  IBM contributor
30May 20, 2010, 6:35:07 PM~Sean Reresongon  IBM contributor
29May 20, 2010, 6:33:13 PM~Sean Reresongon  IBM contributor
28May 20, 2010, 6:30:52 PM~Sean Reresongon  IBM contributor
27May 20, 2010, 6:24:15 PM~Sean Reresongon  IBM contributor
26May 20, 2010, 6:23:06 PM~Sean Reresongon  IBM contributor
25May 20, 2010, 6:20:33 PM~Sean Reresongon  IBM contributor
24May 20, 2010, 6:15:20 PM~Sean Reresongon  IBM contributor
23May 20, 2010, 5:36:12 PM~Zelda Fezboosipulgon  IBM contributor
22May 20, 2010, 3:32:38 PM~Sean Reresongon  IBM contributor
21May 20, 2010, 11:55:59 AM~Sean Reresongon  IBM contributor
20May 19, 2010, 4:31:27 PM~Sean Reresongon  IBM contributor
19May 19, 2010, 4:29:40 PM~Sean Reresongon  IBM contributor
18May 18, 2010, 7:11:34 PM~Sean Reresongon  IBM contributor
17May 18, 2010, 7:09:57 PM~Sean Reresongon  IBM contributor
16May 18, 2010, 7:07:11 PM~Sean Reresongon  IBM contributor
15May 18, 2010, 11:34:23 AM~Sean Reresongon  IBM contributor
14May 18, 2010, 11:11:41 AM~Sean Reresongon  IBM contributor
13May 18, 2010, 11:09:35 AM~Sean Reresongon  IBM contributor
12May 18, 2010, 10:26:10 AM~Sean Reresongon  IBM contributor
11May 18, 2010, 10:10:43 AM~Sean Reresongon  IBM contributor
10May 18, 2010, 9:59:11 AM~Sean Reresongon  IBM contributor
9May 17, 2010, 1:55:42 PM~Sean Reresongon  IBM contributor
8May 17, 2010, 1:45:48 PM~Sean Reresongon  IBM contributor
7May 17, 2010, 1:44:11 PM~Sean Reresongon  IBM contributor
This version (6)May 17, 2010, 11:03:55 AM~Sean Reresongon  IBM contributor
5May 11, 2010, 12:40:41 PM~Sean Reresongon  IBM contributor
4May 4, 2010, 4:48:29 PM~Sean Reresongon  IBM contributor
3May 1, 2010, 12:42:25 PM~Sean Reresongon  IBM contributor
2Apr 30, 2010, 12:43:16 PM~Sean Reresongon  IBM contributor
1Apr 30, 2010, 11:09:24 AM~Paul Kiretex  
Copy and paste this wiki markup to link to this article from another article in this wiki.
Go ElsewhereStay ConnectedAbout
  • HCL Software
  • HCL Digital Solutions community
  • HCL Software support
  • BlogsDigital Solutions blog
  • Community LinkHCL Software forums and blogs
  • About HCL
  • Privacy
  • Accessibility